Add some caveats to the documentation. (#348971)

2006-08-17  Matthias Clasen  <mclasen@redhat.com>

	* gtk/gtkstatusicon.c (gtk_status_icon_get_geometry): Add some
	caveats to the documentation.  (#348971)

diff --git a/ChangeLog b/ChangeLog
index 7f65b13c37ac7c4930af213f111b8002f9995e2d..06b40080731b9c745fa8a77e272c89d4a1d91d4d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-08-17  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkstatusicon.c (gtk_status_icon_get_geometry): Add some
+       caveats to the documentation.  (#348971)
+
 Thu Aug 17 16:19:35 2006  Tim Janik  <timj@imendio.com>
 
        * docs/tutorial/gtk-tut.sgml: fixed buglet from #351759.

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 7f65b13c37ac7c4930af213f111b8002f9995e2d..06b40080731b9c745fa8a77e272c89d4a1d91d4d 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2006-08-17  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkstatusicon.c (gtk_status_icon_get_geometry): Add some
+       caveats to the documentation.  (#348971)
+
 Thu Aug 17 16:19:35 2006  Tim Janik  <timj@imendio.com>
 
        * docs/tutorial/gtk-tut.sgml: fixed buglet from #351759.

diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c
index ca7209491f9d55fde661be9b50e0188a2e8e130d..aa09dba858e2be11ea7f9ee64e177f44dd57fed1 100755 (executable)
--- a/gtk/gtkstatusicon.c
+++ b/gtk/gtkstatusicon.c
@@ -1646,11 +1646,15 @@ gtk_status_icon_position_menu (GtkMenu  *menu,
  * Obtains information about the location of the status icon
  * on screen. This information can be used to e.g. position 
  * popups like notification bubbles. 
+ *
  * See gtk_status_icon_position_menu() for a more convenient 
  * alternative for positioning menus.
  *
  * Note that some platforms do not allow GTK+ to provide 
- * this information.
+ * this information, and even on platforms that do allow it,
+ * the information is not reliable unless the status icon
+ * is embedded in a notification area, see
+ * gtk_status_icon_is_embedded().
  *
  * Return value: %TRUE if the location information has 
  *               been filled in